home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 52 / Amiga Format AFCD52 (Issue 136, May 2000).iso / -serious- / programming / basic / mildred / lha / cnki.lha / cnki / CNKI.readme < prev    next >
Text File  |  1999-04-03  |  4KB  |  134 lines
  1. CNKI File Format By Chris Deeney 1999
  2.  
  3.  
  4. Introduction:
  5. ------------
  6. CNKI is a file format designed to make chunky shapes compact and easy
  7. to load in your programs.
  8.  
  9. This archive contains:
  10.  
  11. CNKI.readme          3651  bytes
  12. BrushConvertor       62232 bytes
  13. CNKI.bb2             3067  bytes
  14. CNKI.bb2.xtra        1222  bytes
  15. CNKI.ascii           3679  bytes
  16.  
  17. The "BrushConvertor" is a utility that will convert IFF brush/animbrush
  18. files into .CNK (CNKI) files.
  19.  
  20. The "CNKI.bb2" is an include file which contains the CNKI routines.
  21.  
  22.  
  23. DISCLAIMER:
  24. ----------
  25. THIS SOFTWARE IS FREE WARE AND CAN BE DISTRIBUTED FREELY AS LONG AS
  26. THE CONTENTS OF THIS ARCHIVE REMAIN UNALTERED, UNLESS YOU HAVE THE
  27. EXPRESSED PERMISSION OF THE AUTHOR.
  28.  
  29. THIS SOFTWARE IS TO BE USED AT YOUR OWN RISK. THE AUTHOR TAKES NO
  30. RESPONSIBILITY FOR DIRECT/INDIRECT DAMAGE OR LOSS OF DATA RESULTING
  31. FROM THE USE/MISUSE OF THIS SOFTWARE.
  32.  
  33.  
  34. Requirements:
  35. ------------
  36. To use this software you will require:
  37.  
  38. Blitz Basic 2, including libraries,
  39.  
  40. Mildred V1.48 or better, by Paul West,
  41.  
  42. An AGA! Amiga! or Amiga with GFX card :),
  43.  
  44. A Hard Drive would be nice ;),
  45.  
  46. A 68030 cpu or better is recommended, but not essential ;)
  47.  
  48.  
  49. Usage:
  50. -----
  51. The routines in this archive are to be used with "Mildred"...
  52.  
  53. *BrushConvertor:
  54.  
  55. The BrushConvertor can convert an IFF brush/animbrush file into a
  56. .CNK (CNKI) file with some very nice compression ratios eg.
  57.  
  58. IFF AnimBrush= 4210 bytes compressed to 818 bytes in .CNK file.
  59.  
  60. Please NOTE that the compression ratios vary.
  61.  
  62. To convert an IFF brush/animbrush simply execute the BrushConvertor,
  63. a file requestor will pop-up - select a brush/animbrush.
  64.  
  65. A second file requestor will pop-up asking for a destination and
  66. file name, after selecting a file name, BrushConvertor will
  67. continue to convert the choosen file, showing it's progress with a
  68. nice progress indicator :) After it has finnished it will exit.
  69.  
  70. You can set BrushConvertor to use compression or not by altering the
  71. tooltype "COMPRESSION" which can be set to YES or NO.
  72.  
  73. You can also make BrushConvertor save the palette (CMAP) of the brush/
  74. animbrush by setting the "SAVEPALETTE" tooltype to YES.
  75.  
  76.  
  77. *CNKI.bb2
  78.  
  79. Contains 2 functions. Put this file in your program's directory and add
  80. this line at the top of your program 'Include "CNKI.bb2"' :
  81.  
  82. success = LoadCNK{ shapenumber.w , filepath$ }
  83.  
  84. Loads a .CNK file into Mshapes shapenumber.w
  85.  
  86. Where shapenumber.w is the number of the Mshape you want to load into.
  87. filepath$ is the full path of the .CNK file.
  88. success returns -1 if it succeeds or one of the following error codes:
  89.  
  90. #0 = File doesn't exist / Can't read file!
  91. #1 = Not a CNKI file format!
  92. #2 = File is corrupt!
  93. #3 = Can't allocate enough fast ram!
  94. #4 = Illegal parameters!
  95.  
  96.  
  97. frames.w = CnkFrames{ filepath$ }
  98.  
  99. Returns the number of frames in a .CNK file.
  100.  
  101. Where filepath$ is the complete path of the .CNK file.
  102. frames.w returns the number of frames in the .CNK file or returns -1 for
  103. failure.
  104.  
  105.  
  106. Please NOTE that these routines use file 0 for loading so don't have a
  107. file 0 open when calling these routines :)
  108.  
  109.  
  110. Contacting the Author:
  111. ---------------------
  112. To contact me for any reason, you can email me at:
  113.  
  114. chris@addnet.demon.co.uk
  115.  
  116. Or catch me on IRC Dalnet "PrinceD"
  117. #AmIRC #Ungabunga #Amazing or /whois me :)
  118.  
  119.  
  120. Greetz!:
  121. -------
  122. Greetz goes to (in no perticular order):
  123.  
  124. Sparkster, [^CRASH^], TroySwoosh, FoxyLady, leki, Drad, Sp^, NinjA,
  125. Epsilon, and loads of other IRC buddies :)
  126.  
  127. Guys on the blitz list:
  128.  
  129. Paul West, Anton Reinauer, Gareth Griffiths, Dave Newton, Paul Burkey,
  130. Curt Esser, Mikkel Lokke, And all the other cool guyz on the list :)
  131.  
  132. Join the list, it's grrreat fun, honest :)
  133.  
  134.